FoxitPDFSDKPython2.LayerTree类 参考
类 FoxitPDFSDKPython2.LayerTree 继承关系图:
Public 成员函数 | |
| def | LayerTree (document) |
| 从PDF文档构造的构造函数。 更多... | |
| def | LayerTree (other) |
| 拷贝构造函数。 更多... | |
| def | GetDict () |
| 获取当前对象的字典。 更多... | |
| def | GetOCGs () |
| 从当前对象获取"OCGs" PDF数组。 更多... | |
| def | GetOCGsByPageIndex (page_index) |
| 获取在指定页面上找到的OCG对象数组。 更多... | |
| def | GetRootNode () |
| 获取根图层节点。 更多... | |
| def | IsEmpty () |
| 检查当前对象是否为空。 更多... | |
| def | SetBaseState (state) |
| 为默认配置中的所有图层设置基础状态。 更多... | |
静态 Public 属性 | |
| e_StateOFF = _fsdk.LayerTree_e_StateOFF | |
| 状态为关闭。 | |
| e_StateON = _fsdk.LayerTree_e_StateON | |
| 状态为开启。 | |
| e_StateUnchanged = _fsdk.LayerTree_e_StateUnchanged | |
| 状态为未改变。 | |
| e_StateUndefined = _fsdk.LayerTree_e_StateUndefined | |
| 状态为未定义。 | |
详细描述
PDF图层节点存储在PDF图层树中。如果用户想要检索图层节点，用户必须首先从PDF文档 构造一个图层树对象，然后调用函数 FoxitPDFSDKPython2.LayerTree.GetRootNode 获取 整个图层树的根图层节点。然后，用户可以从根图层节点枚举图层树中的所有节点。
构造及析构函数说明
◆ LayerTree() [1/2]
| def FoxitPDFSDKPython2.LayerTree.LayerTree | ( | document | ) |
从PDF文档构造的构造函数。
构造的图层树对象可以与PDF文档中存在的图层树关联。 如果PDF文档中没有图层树（可以通过函数 FoxitPDFSDKPython2.PDFDoc.HasLayer 判断）， 构造的图层树对象将构建图层相关的字典。
- 参数
-
[in] document 有效的PDF文档对象。
◆ LayerTree() [2/2]
| def FoxitPDFSDKPython2.LayerTree.LayerTree | ( | other | ) |
拷贝构造函数。
- 参数
-
[in] other 另一个图层树对象。
成员函数说明
◆ GetDict()
| def FoxitPDFSDKPython2.LayerTree.GetDict | ( | ) |
获取当前对象的字典。
- 注解
- 请参考<PDF Reference 1.7> P375中的"Optional Content Properties Dictionary"了解更多详情。
- 返回
- 当前对象的字典。如果有任何错误，此函数将返回null。
◆ GetOCGs()
| def FoxitPDFSDKPython2.LayerTree.GetOCGs | ( | ) |
从当前对象获取"OCGs" PDF数组。
- 注解
- 请参考<PDF Reference 1.7> P375中的"Optional Content Properties Dictionary"了解更多详情。
- 返回
- "OCGs" PDF数组。 如果没有"OCGs"条目或发生任何错误，此函数将返回null。
◆ GetOCGsByPageIndex()
| def FoxitPDFSDKPython2.LayerTree.GetOCGsByPageIndex | ( | page_index | ) |
获取在指定页面上找到的OCG对象数组。
- 参数
-
[in] page_index 要检索的子项的页面索引。有效范围：从0到(数量-1)。 数量由函数 FoxitPDFSDKPython2.PDFDoc.GetPageCount 返回。
- 返回
- 图层节点数组对象。
◆ GetRootNode()
| def FoxitPDFSDKPython2.LayerTree.GetRootNode | ( | ) |
获取根图层节点。
获取根图层节点后，用户可以通过LayerNode类的函数 枚举当前图层树中的所有图层节点。
- 返回
- 根图层节点。
◆ IsEmpty()
| def FoxitPDFSDKPython2.LayerTree.IsEmpty | ( | ) |
检查当前对象是否为空。
当当前对象为空时，表示当前对象无用。
- 返回
- true表示当前对象为空，false表示不为空。
◆ SetBaseState()
| def FoxitPDFSDKPython2.LayerTree.SetBaseState | ( | state | ) |
为默认配置中的所有图层设置基础状态。
如果用户希望新状态对渲染结果生效，请在此函数成功后构造一个新的图层上下文对象， 然后使用新的LayerContext来渲染器进行渲染。
- 参数
-
[in] state 图层用途状态。请参考从 FoxitPDFSDKPython2.LayerTree.e_StateON 开始的值， 应该是这些值中的一个，除了 FoxitPDFSDKPython2.LayerTree.e_StateUndefined 。
- 返回
- true表示成功，false表示失败。
